Skip to content

Comments

Rewrite outdated docs, bump to 8.4#1258

Merged
droserasprout merged 17 commits intonextfrom
docs/outdated-sections
May 19, 2025
Merged

Rewrite outdated docs, bump to 8.4#1258
droserasprout merged 17 commits intonextfrom
docs/outdated-sections

Conversation

@droserasprout
Copy link
Collaborator

No description provided.

@droserasprout droserasprout added this to the 8.3.4 milestone May 18, 2025
@droserasprout droserasprout added the documentation Improvements or additions to documentation label May 18, 2025
@droserasprout droserasprout changed the title Rewrite outdated sections in docs Rewrite outdated in docs, bump to 8.3 May 18, 2025
@droserasprout droserasprout changed the title Rewrite outdated in docs, bump to 8.3 Rewrite outdated docs, bump to 8.4 May 18, 2025
@droserasprout droserasprout marked this pull request as ready for review May 18, 2025 21:21
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR updates various documentation files to reflect the new DipDup version 8.4.0 and revises several guides and changelogs to remove outdated instructions.

  • Update version numbers in configuration and changelog files.
  • Rewrite and reformat documentation sections (e.g. configuration merging, Docker, FAQ) for clarity and consistency.
  • Remove outdated backup examples from the docs.

Reviewed Changes

Copilot reviewed 313 out of 313 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
src/demo_blank/.dockerignore Updated header comment to reflect version 8.4.0.
pyproject.toml Bumped project version from 8.3.4 to 8.4.0.
docs/9.release-notes/_8.4_changelog.md Added changelog entries for release 8.4.0.
docs/9.release-notes/_8.3_changelog.md Updated changelog by removing outdated entries.
docs/8.examples/_demos_table.md Updated demo project URLs to version 8.4.0.
docs/5.advanced/6.sqd-cloud.md Added a warning banner and updated commands for cloud deployment.
docs/5.advanced/5.backups.md Removed legacy backup and restore documentation.
docs/5.advanced/2.environment-variables.md Revised instructions and corrected typos.
docs/5.advanced/1.docker.md Updated Docker instructions and command examples.
docs/15.glossary.md Refined glossary terms and definitions.
docs/14.contributing.md Revised contributing guidelines and development commands.
docs/12.faq.md Updated FAQ answers with clearer instructions.
docs/10.supported-networks/0.overview.md Added instruction to generate an env file using a CLI command.
docs/1.getting-started/6.models.md Streamlined models documentation and updated terminology.
docs/1.getting-started/5.database.md Added a warning banner regarding migration practices.
docs/1.getting-started/4.package.md Updated project structure and package merging details.
docs/1.getting-started/3.config.md Revised config merging instructions and environment variable usage.
docs/1.getting-started/1.installation.md Updated Docker installation instructions and details.
Makefile Removed outdated schema export commands.
CHANGELOG.md Updated version tags and reference links to 8.4.0.

@droserasprout droserasprout merged commit adb2d0e into next May 19, 2025
6 checks passed
@droserasprout droserasprout deleted the docs/outdated-sections branch May 19, 2025 18:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants